Package com.cisco.pt.ipc.sim
Interface ICMPSignature
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
ICMPSignatureImpl
Information provided by the PKI file:
\class IcmpSignature
\brief IcmpSignature handles and manipulates ICMP signatures.
\example network().getDevice("Router0").getProcess("IpsProcess").getIcmpSignature()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionbooleanInformation provided by the PKI file:getEventActionAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:intgetSigId()Information provided by the PKI file:intgetSubId()Information provided by the PKI file:voidsetEnabled(boolean val) Information provided by the PKI file:voidsetEventAction(SigEventAction eAction) Information provided by the PKI file:voidsetRetired(boolean val) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getSigId
int getSigId()Information provided by the PKI file:
\brief Returns the signature ID. \return int, the signature ID.- Returns:
- int Returns a int
-
getSubId
int getSubId()Information provided by the PKI file:
\brief Returns the signature sub-id. \return int, the signature sub-id.- Returns:
- int Returns a int
-
getRetired
boolean getRetired()Information provided by the PKI file:
\brief Returns the retired value for the ICMP signature. \return Bool, the retired value. Retired values: eDefault = 0, eFalse = 1, eTrue = 2- Returns:
- boolean Returns a boolean
-
getEnabled
boolean getEnabled()Information provided by the PKI file:
\brief Returns the enabled value. \return Bool, the enabled value. Enabled values: eDefault = 0, eFalse = 1, eTrue = 2- Returns:
- boolean Returns a boolean
-
getEventActionCount
int getEventActionCount()Information provided by the PKI file:
\brief Returns the event action count. \return int, the event action count.- Returns:
- int Returns a int
-
getEventActionAt
Information provided by the PKI file:
\brief Returns the event action at the specified index. \param index, the index of the event action of interest. \return SigEventAction, the event action at the specified index. Event actions: eInvalid = -1, eProduceAlert = 0, eDenyPacketInline = 1, eDenyAttackerInline = 2, eDenyConnInline = 3, eRstTCPConn = 4,- Parameters:
index- Takes in a parameter of index- Returns:
- SigEventAction Returns a SigEventAction
-
setRetired
void setRetired(boolean val) Information provided by the PKI file:
\brief Sets the retired value. \param Bool, the retired value. Retired values: eDefault = 0, eFalse = 1, eTrue = 2- Parameters:
val- Takes in a parameter of val
-
setEnabled
void setEnabled(boolean val) Information provided by the PKI file:
\brief Sets the enabled value. \param Bool, the enable value. Enabled values: eDefault = 0, eFalse = 1, eTrue = 2- Parameters:
val- Takes in a parameter of val
-
setEventAction
Information provided by the PKI file:
\brief Sets the event action for the ICMP signature. \param eAction, the event action at the specified index. Event actions: eInvalid = -1, eProduceAlert = 0, eDenyPacketInline = 1, eDenyAttackerInline = 2, eDenyConnInline = 3, eRstTCPConn = 4,- Parameters:
eAction- Takes in a parameter of eAction
-